<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Fontmatrix User Manual - Contributing - Translating</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link href="style.css" rel="stylesheet" type="text/css" />
</head>
<body>
<h2>Translating</h2>

<h3>Translating desktop entry</h3>

<p>On Linux systems .desktop files are used to build system menus that lists applications available to users. Fontmatrix ships with such a file as well. It is located in root directory with source code and gets installed to /usr/share/applications or /usr/local/share/applications, depending on your preferences.</p>

<p>To get localized menu entry you need to do a very simple thing:</p>

<ol>
<li>Open this file in your preferred text editor and make sure you opened it as a UTF-8 encoded text file.</li>
<li>Create a new entry which looks like "Comment[LANG]=A font manager", where LANG is a two-letter code for your language (as referenced by <a href="http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">ISO-639-1</a>) and everything after "=" is translated.</li>
<li>Create a new entry which looks like "GenericName[LANG]=A font manager".</li>
<li>Save.</li>
<li>Test by running 'sudo make install' (if Fontmatrix is already installed or just 'sudo cp fontmatrix.desktop /usr/share/applications/' and look in the menu.</li>
</ol>

<p><a href="contributing_testing.html">Send</a> the updated file to us.</p>

<h3>Translating user interface</h3>

<p>The very first thing you need to translate Fontmatrix into your native language is to get source code from the current developpement branch. To do this, you need a Subversion client (<span class="code">svn</span> being the regular command line client). Then type 

<p><tt>svn co http://svn.gna.org/svn/undertype/trunk/tools/typotek fontmatrix</tt></p>

<p>somewhere in your home directory to fetch source code, so that you always have access to it.</p>

<p>Then you will need to install Qt development package that contains Linguist&nbsp;&mdash; the application to assist you with translating. On Linux start your package manager and look for a package named something like qt4-dev, install it.</p>

<p>The next steps are as follows:</p>

<ol>
	<li>Go to the top level directory of source code.</li>
	<li>Create the build directory eg: <span class="code">mkdir build</span> and cd into it.</li>
	<li>Run Cmake command with whatever options you want plus -DTRANSLATOR:string=LOCALE, where LOCALE is a two-letter code for your language (as referenced by <a href="http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes">ISO-639-1</a>), lowercase, e.g. <em>fr</em> for French or <em>de</em> for German.
	If necessary, you can specify a country code and thus form a string like <em>fr_FR</em></li>
	<li>Run "make translation" to create a new translation file in fontmatrix/src/messages/ directory.</li>
	<li>Open your fontmatrix-LOCALE.ts file in Linguist and start translating.</li>
	<li>To test your translation, run <span class="code">make install</span> in the build directory. This will create a binary file called fontmatrix-LOCALE.qm (and Fontmatrix itself if you did not run this command before) and install it in the right place. If the LOCALE for which you translate is not the one which is set for your system, run <span class="code">LC_ALL=LOCALE fontmatrix</span> to tell Fontmatrix to load that specific LOCALE.</li>
	<li>When your work is done, compress this fontmatrix-LOCALE.ts file to a ZIP, GZ or BZ2 archive and submit it via <a href="contributing_testing.html">patches and patches tracker</a> or tell us about it on <a href="resources.html">IRC</a> and we will help you to sort this out.</li>
</ol>

<p>Here are some tips to help you make translation better.</p>

<p>Translating Fontmatrix takes a while, so it's best to translate those parts of user interface that you use most of the time. This will give you a false, but useful feeling of accomplishment and motivation to finish the whole work.</p>

<p>Test your translation as frequently as possible. This is especially important for dialogs that you rarely use.</p>

<p>Make sure you find a good balance between short and easy to understand phrases and words. English language is known to have relatively shorter words, so in most cases your translation will make user interface a bit larger. But if you start using abbreviations or shorter synonyms that don't quite fit the context, users won't appreciate that either.</p>

<p>A lot of translatable messages use variables like <em>%1</em>. Those are substituted by some values. For example, in "Block (%1):" (<em>Glyphs</em> tab) this variable is substituted with percentage of a chosen Unicode block's coverage, e.g.: "Block (74%):". When you type these variables manually, you can make a mistake and the trick with a variable won't work. So it's better to paste original text to translation entry field by pressing <b>Ctrl</b>+<b>B</b> in Linguist and then replace this original text with translation, leaving all present variables intact.</p>

<p>A good part of translatable messages are names of Unicode blocks and OpenType features. Even though these technologies are meant to serve wide world community with all its complex languages and scripts, it is typical to have little to no information on them in a language other than English. This is 21st century to you. So please refer to good solid dictionaries for correct names of languages that are used for most Unicode blocks, to <a href="http://www.unicode.org/standard/standard.html">Unicode specification</a> for the rest of the blocks and to <a href="http://www.microsoft.com/typography/otspec/">OpenType specification</a> for names of OpenType features that you see in the <em>Sample text</em> tab.</p>

<h3>Translating documentation</h3>

<p>The documentation is inside <em>help</em> directory and consists of menu.xml file that defines table of contents, HTML files with text and illustrations in PNG or JPEG files.</p>

<p>Every translation is kept in its own directory named with two-letter language code like <em>ru</em> for Russian or <em>es</em> for Spanish. So download source code, unpack it and start with creating this directory.</p>

<p>Now copy contents of <em>en</em> directory to your language directory. Before you start translating, open help/LANGUAGE/CMakeLists.txt file in your preferred editor and replace all instances of "_EN" with "_LANGUAGE", where LANGUAGE is a two-letter code for your language as well, uppercase. Then open help/CMakeLists.txt and add another line that looks like this:</p>

<p>ADD_SUBDIRECTORY(${FM_HELP_DIR}LANGUAGE)</p>

<p>where LANGUAGE is a two-letter code for your language, lowercase this time.</p>

<p>These two files are used by the build system to find out what files to install.</p>

<p>Start translating. It's best to translate table of contents first and proceed with actual content later. To translate table of contents open menu.xml file in your editor of choice and translate values of every <em>text</em> attribute. E.g. for &lt;area text="Setting up" file="setting_up.html"&gt; translatable text will be "Setting up".</p>

<p>To test your translation open a terminal window, go to the top level directory with source code, rebuild and reinstall Fontmatrix. After you rebuild it for the first time, you will only need to run 'sudo make install' to update files.</p>

<p>If user interface is not localized, you might want to do it before translating documentation. Some users might complain and tell you that user interface in English is a de-facto standard and thus localized documentation should refer only to English UI. But this is just because they have grown up to use unlocalized software, so don't worry, let them play silly buggers and move on.</p>

<p>Some illustrations actually display other applications like FontForge which may be not localized for your language. In that case just use already available screenshots from English version of the documentation.</p>

<p>The English (and Russian) translations have screenshots with <em>Dust</em> theme for both GTK+ and Metacity (and GTK+ engine for Qt), and Droid Sans 9pt font. You don't have to try to reproduce that, but please be visually consistent across your translation.</p>

<p>Please keep all of your illustrations below 800 pixels on the longer side.</p>

<p>When you are done, archive help/LANGUAGE directory with your translation and <a href="contributing_testing.html">send it</a> to us.</p>

</body>
</html>
